home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 (Alt) / MACD 5.bin / workbench / tools / czesc_1 / exa / exa_english.doc < prev    next >
Encoding:
Text File  |  1994-06-02  |  5.6 KB  |  152 lines
  1.  
  2.                 EXA 0.1
  3.  
  4.             © 1994 David Gaussinel
  5.                    Cardware
  6.  
  7. INTRODUCTION
  8.  
  9.     Exa was made to use the wonderful library called Whatis.library from 
  10. any software. I have seen some softwares using it but none of them satisfied me, 
  11. so I have decided to create the software I dreamed of. But if you knew my other
  12. softwares you should know that I'm used to programming with Amos. It was of 
  13. course unthinkable to create a software like Exa with Amos, so I have decided to 
  14. have a look on the E. It allowed me to realize what I dreamed of.
  15.  
  16.  
  17. OBJECT
  18.  
  19.     Exa recognizes the type of a file, thanks to the Whatis.library, and 
  20. allows the user to perform on this file actions he would have planned. 
  21. E.g. you give to Exa a file that it recognizes as an ASCII text file, it then 
  22. opens a requester giving you several actions you have previously defined. 
  23. The actions can be: Read, Edit, Print... for an ASCII text file.
  24.  
  25.  
  26. LEGAL STUFF
  27.  
  28.     Exa is distributed "AS IS". In no way the author can't be made 
  29. responsible for any damages caused by the use of Exa. You use this software 
  30. to your own risks and you have been warned. However, I don't see what damages
  31. Exa could do :-).
  32.     Exa 0.1 is copyrighted by David Gaussinel. The use and the spreading 
  33. of this program is free. You can copy it, eat it... but it is forbidden to 
  34. sell it! This interdiction does not cover the fees of the spreading. In 
  35. one word, it is not allowed to spread it on disks worth more than 25FF 
  36. ($5 or 10DM). In France, however some spreaders are exceeding this tariff by 
  37. far... It's up to you to compare the prizes.
  38.     Exa is cardware i.e. if you appreciate and/or use this program, you'd 
  39. better send a post card to the author to point it out, and also to let him 
  40. know that improvements and future versions would be welcome. My address is:
  41.         David Gaussinel
  42.         18 rue Fenelon
  43.         24200 Sarlat
  44.         France
  45.     Reqtools.library © Nico Francois
  46.     Whatis.library © Sylvain Rougier & Pierre Carette.
  47.  
  48. Fred Fish have an explicit permission for including in its collection, also        
  49. Pascal Rullier in BUGSSDP collection.
  50.  
  51. REQUIREMENTS
  52.     
  53.     Exa would work only on 2.0+ systems. Libraries Reqtools and Whatis 
  54. must also be present in LIBS:.
  55.  
  56.  
  57. USAGE
  58.     
  59.     Exa is a shell command, in other words it is useless to run it from the
  60. WorkBench. A requester will be displayed giving you the ident of the program.
  61.  
  62.     From the shell, you can do: Exa ? to obtain the options syntax as with
  63. all classic shell commands.
  64.  
  65.     Here are the options; NAME/A/M, CFG=CONFIG/K, PUBSCREEN/K, NOREQ/S, 
  66. NOCFG/S.
  67.  
  68.     First of all you have to specify the name of the file(s) to be 
  69. examinated. CFG is used to define the name of the configuration file for Exa.
  70. By default this file will be ENV:Exa.prefs. PUBSCREEN specifies a public screen 
  71. on which would be opened the requesters. If you indicate NOREQ that means that 
  72. you don't want any requester, whereas NOCFG means that you don't want Exa to 
  73. load a configuration file.
  74.  
  75.     
  76. THE CONFIGURATION FILE
  77.     
  78.     Let's talk about that configuration file which is the central point 
  79. of Exa. For each type recognized by Whatis, it has the following format:
  80.  
  81. TYPE Text
  82.    GAD _Lis|_Imprime
  83.    Bin:Muchmore %f
  84.    Type >PRT: %f
  85. ENDTYPE
  86.     
  87.     We have here defined the actions for the text type. Two actions will 
  88. occur which are Lis and Imprime. After the indicator GAD we find on the same 
  89. line the text which will appear in gadgets. The sign _ indicates a shortcut 
  90. whereas | separates gadgets.
  91.  
  92.     Then, on each following line, the executed command line is defined in
  93. order where %f represents the name of the selected file.
  94.  
  95.     But in certain case it can so happen that you wish many types to have
  96. the same actions. In this case you can define only one and indicate that the 
  97. others have the same actions than it. In our example, we write:
  98.  
  99. TYPE Doc
  100.    IDEM Text
  101. ENDTYPE
  102.  
  103.     for the doc type or the text type, which are not really so far, to 
  104. have the same actions type.
  105.  
  106.     Finally, you can desire thet not a  requester opens and that an action 
  107. occurs immediatly on this file. Let's imagine that you want any picture to 
  108. be displayed, you can write:
  109.  
  110. TYPE ILBM
  111.    NOREQ
  112.    Bin:Mostra %f
  113. ENDTYPE
  114.  
  115.     Last but not least: you can write several commands on a same 
  116. instruction line separated by a | such as for the gadgets. The commands will 
  117. be executed then one by one. For example you can write:
  118.  
  119. TYPE LHArc
  120.    GAD _Liste
  121.    Bin:Lha v >T:temp|bin:MM T:temp|delete T:temp
  122. ENDTYPE
  123.  
  124.     This will allow you then to list the content of Lha archives and to 
  125. read them thanks to Muchmore.
  126.  
  127.  
  128. PRACTICAL USAGE
  129.     
  130.     As you have probably noted Exa has no interface but all is done thru
  131. the shell. However a good way to use Exa is for example to use it with 
  132. ToolManager creating a Dock, an Appicon or a Menu. In this way, if you have 
  133. created for example an Appicon Exa, you could click on an icon from the 
  134. WorkBench and release it on the Appicon Exa to examinate the file. You can 
  135. also use Exa with any file manager such as BrowserII, Directory Opus, MegaD.... 
  136. where you define a menu or a gadget for Exa. Moreover, Exa being openable on a 
  137. public screen, you could see the requester on the screen you want.
  138.  
  139.  
  140. GREETINGS
  141.     
  142.     To Sada for having designed the icon many times before the end of the 
  143. program in five minutes a day in August. If you want to use Exa in Appicon 
  144. with ToolManager, you can use this icon.
  145.     Very special thanks to Sylvain Rougier and Pierre Carette for having 
  146. written the Whatis.Library which is very powerful.
  147.     I thank Nico Francois too for all his high quality PD programs and 
  148. particulary for the Reqtools.Library.
  149.     Finally, I really thank the E author Wouter Van Oortmerssen for his 
  150. marvellous language.
  151.  
  152.